Vcenter Deployment LocationSpec

The Vcenter Deployment LocationSpec schema is used to pass the container ESXi or vCenter server of the VM to patch the size of this appliance.

This schema was added in vSphere API 6.7.

JSON Example

{
    "hostname": "string",
    "https_port": 0,
    "ssl_thumbprint": "string",
    "ssl_certificate": "string",
    "ssl_verify": false,
    "username": "string",
    "password": "string"
}

string

hostname

Required

The IP address or DNS resolvable name of the container.

This property was added in vSphere API 6.7.

integer As int64 As int64

https_port

Optional

The HTTPS port of the container.

This property was added in vSphere API 6.7.

If missing or null, port 443 will be used.

string

ssl_thumbprint

Optional

SHA1 thumbprint of the server SSL certificate will be used for verification.

This property was added in vSphere API 6.7.

This property is only relevant if ssl_verify is missing or null or has the value true.

string

ssl_certificate

Optional

The SSL Certificate of the server that will be used for verification. The value should be a single x509 certificate encoded in PEM format.

This property was added in vSphere API 9.0.0.0.

This property is only relevant if ssl_verify is missing or null or has the value true.

boolean

ssl_verify

Optional

SSL verification should be enabled or disabled. If ssl_verify is true and and ssl_thumbprint is missing or null, the CA certificate will be used for verification. If ssl_verify is true and ssl_thumbprint is set then the thumbprint will be used for verification. No verification will be performed if ssl_verify value is set to false.

This property was added in vSphere API 6.7.

If missing or null, ssl_verify true will be used.

string

username

Required

The administrator account on the host.

This property was added in vSphere API 6.7.

string As password As password

password

Required

The administrator account password.

This property was added in vSphere API 6.7.